fix: standardize json context labels - #37
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Standardizes the JSON-editor context terminology across the dashboard UI, docs, and Playwright E2E coverage so users can clearly distinguish between create payload editing, direct Admin API patching, plugin config editing, and API Console request/response editing.
Changes:
- Renamed UI labels/messages to use distinct context names: Payload JSON, Admin API JSON, Plugin JSON, Request JSON, and Response JSON.
- Updated JSON editor standard/design docs and getting-started guidance to match the new UI terminology.
- Refreshed E2E test names and selectors to target the updated tab/button labels.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/routes/raw_api/index.tsx | Renames API Console request/response JSON labels and related error/action text. |
| src/components/page/AdminApiJsonEditor.tsx | Updates tooltips to explicitly reference “Admin API JSON”. |
| src/components/form/FormJsonTabs.tsx | Renames create/edit JSON tabs to “Payload JSON” / “Admin API JSON” and updates helper copy. |
| src/components/form-slice/FormItemPlugins/PluginEditorDrawer.tsx | Renames plugin editor JSON tab/actions/ARIA labels to “Plugin JSON”. |
| src/components/form-slice/FormItemPlugins/index.tsx | Updates plugin warnings to reference “Plugin JSON” mode. |
| e2e/tests/routes.edit-payload-preservation.spec.ts | Updates test names and tab selectors for “Admin API JSON”. |
| e2e/tests/resource-required-templates.spec.ts | Updates create-form selectors for “Payload JSON” and plugin dialog “Plugin JSON”. |
| e2e/tests/plugin_metadata.crud-required-fields.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/plugin_metadata.crud-all-fields.spec.ts | Updates plugin dialog selectors and error-action button names to “Plugin JSON”. |
| e2e/tests/plugin_configs.crud-required-fields.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/plugin_configs.crud-all-fields.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/hot-path.upstream-service-route.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/global_rules.crud-required-fields.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/global_rules.crud-all-fields.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/consumers.credentials.list.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/consumer_groups.crud-required-fields.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/consumer_groups.crud-all-fields.spec.ts | Updates plugin dialog tab selectors to “Plugin JSON”. |
| e2e/tests/api-console.spec.ts | Updates API Console error-action selector to “Format Request JSON”. |
| e2e/tests/admin-ux-helpers.spec.ts | Renames test descriptions to match “Admin API JSON” terminology. |
| docs/en/getting-started.md | Updates getting-started copy to distinguish “Admin API JSON” vs “Payload JSON”. |
| docs/design/json-editor-standard.md | Updates JSON editor standard to enumerate and define the new context names. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
1086
to
1088
| <div className={classes.responseTitle}> | ||
| <span>Response</span> | ||
| <span>{responseView === 'Headers' ? 'Response Headers' : 'Response JSON'}</span> | ||
| {response && statusColor && ( |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification